home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 001 / tmodem23.arc / TM.DOC < prev    next >
Encoding:
Text File  |  1985-05-15  |  15.6 KB  |  302 lines

  1.  
  2.                            Documentation for TMODEM
  3.  
  4.       TMODEM is short for Turbo Modem.  A communications program for IBM
  5.       Personal Computers and compatible units.  The author, Paul Meiners,
  6.       and his company, P & M Software, reserve the copyright to this program
  7.       and all related materials.  The user is granted a license to use the
  8.       program and is encouraged to make a donation if the program is found to
  9.       be useful.  $20 is recommended.  Send donations to the following address:
  10.  
  11.                           P & M Software Company
  12.                           9350 Country Creek #30
  13.                           Houston, Texas 77036
  14.  
  15.       In addition, the user is granted the right to make unlimited copies
  16.       of the program and to distribute these copies as he desires, except
  17.       that the author reserves the sole right to distribute the program
  18.       for profit.  The user may ask for a duplication charge, not to exceed
  19.       $5 per copy.
  20.  
  21.  
  22.       Features:
  23.  
  24.          1. Limited VT-100 emulation.
  25.          2. ANSI.SYS style color graphics.
  26.          3. BASIC style PLAY for single voice music.  Nice, but due
  27.             to PASCAL's limited sound capability, it plays in foreground,
  28.             so the serial input buffer may wrap around while the music
  29.             plays.  The serial input buffer contains 5k bytes.
  30.          4. Fully buffered, interrupt driven, serial I/O.
  31.          5. XMODEM file transfer.
  32.          6. Removable window subsystem.
  33.          7. Telephone directory, with up to 999 entries.
  34.          8. File capture, limited ONLY by the amount of available
  35.             memory.
  36.          9. ASCII file transmission, using XON/XOFF protocol.
  37.         10. Utility package of BASIC style procedures and
  38.             functions.
  39.         11. Full control of all communication parameters.
  40.         12. 40 macro keys, to store logon, passwords, etc.
  41.  
  42.  
  43.       Most of the features of the program are self-documenting, however
  44.       for the sake of the novice user, some explanation is necessary.
  45.  
  46.          The program is distributed in .COM, which can be executed
  47.          immediately by placing your disk into drive A, changing the
  48.          default drive to A, if not already, then typing the name of the
  49.          program, TM.
  50.  
  51.          Once the user has successfully executed the program, the copy-
  52.          right notice will appear, and the user will be asked if music
  53.          is wanted, strike a "y" if you want music, if not, then strike
  54.          any other key.  The on-line screen will then appear.  At the
  55.          bottom of the online screen appears a reminder of the most
  56.          frequently used commands.  These commands may be selected by
  57.          depressing and holding the ALT key along with the indicated ALPHA
  58.          key.  If the user needs a command that does not appear on the screen,
  59.          a complete list of available commands can be obtained by selecting
  60.          ALT-H.  Commands may be selected while the HELP screen is still on
  61.          screen, so that the user does not need to call up the HELP screen
  62.          repetitively.  Here is a brief description of each command:
  63.  
  64.          ALT-T .... Terminate and return to DOS.
  65.                     If other windows are open on the screen, this command
  66.                     will be deferred until all windows have been closed.
  67.  
  68.          ALT-R .... Receive a file using XMODEM protocol.
  69.  
  70.          ALT-X .... Transmit a file using XMODEM protocol.
  71.  
  72.          ALT-A .... Transmit a file using the ASCII XON/XOFF protocol,
  73.                     where the DC1 character is used for XON and the
  74.                     DC3 character is used for XOFF.
  75.  
  76.          ALT-C .... Turn capture mode ON if it is OFF, or OFF if it is ON.
  77.                     When this mode is turned OFF, either thru the ALT-C
  78.                     command or with the ALT-T command, the user will be
  79.                     prompted for a file name wherein to save the contents of
  80.                     the capture buffer.  During capture mode operations, a
  81.                     '*' or 'W' will appear in the lower left corner of the
  82.                     screen.  The '*' reminds the user that capture mode
  83.                     is ON, the 'W' warns the user that memory space is
  84.                     short.  Capture mode will make use of all available
  85.                     memory.  Capture mode is useful for recording complete
  86.                     sessions for review later, so you don't read so much
  87.                     on those long distance phone calls.
  88.  
  89.          ALT-L .... Display disk directory, under a user supplied mask.
  90.                     For example, to see all files on the logged drive
  91.                     and current directory, the user would enter the mask
  92.                     "*.*", when prompted.   Or see just the files with an
  93.                     extension of .PAS by entering the mask "*.pas", when
  94.                     prompted.
  95.  
  96.          ALT-N .... Allows the user to change to a new logged drive and/or
  97.                     new current directory.
  98.  
  99.          ALT-V .... View the contents of a file, uses the same style as
  100.                     MORE, the DOS utility.  Use the "End" key to stop the
  101.                     command.
  102.  
  103.          ALT-K .... Kill a file.  Delete a file from the disk.
  104.  
  105.          ALT-Y .... Copy a file.  This procedure will copy any unprotected
  106.                     file, however it copies in multiples of 128 bytes, so the
  107.                     resultant file may be a little longer than the original.
  108.                     This is OK for most applications, but some programs are
  109.                     sensitive to the lengths of files, in which case this
  110.                     procedure, probably, will produce unusable output.
  111.                     Also, filenames must be fully specified.  No wildcards
  112.                     are allowed, ONLY the current drive and directory need not
  113.                     be specified.
  114.  
  115.          ALT-M .... Macro key management.  Allows the user to define the
  116.                     contents of the function keys F1 thru F10, and all
  117.                     combinations of the function keys and shift, Ctrl or
  118.                     Alt.  This gives the user 40 different macro keys.
  119.  
  120.          ALT-H .... Produces the HELP screen for the user.
  121.  
  122.          ALT-I .... Reconfigure the program, without exiting to DOS.
  123.                     The parameters listed below for the .CNF file can be
  124.                     changed via this command.
  125.  
  126.          ALT-S .... Switch communication parameters.  The program starts
  127.                     with these default values: 1200 baud, No Parity,
  128.                     8 data bits, 1 stop bit.  Permissible values for the
  129.                     baud rate are: 300, 1200, 2400.
  130.  
  131.          ALT-D .... Modem dialing and phone directory management.
  132.                     The phone directory may have up to 999 entries,
  133.                     if there is enough disk space.  The directory screen will
  134.                     automatically disappear whenever carrier is detected,
  135.                     unless the Forced Carrier config param is "TRUE".
  136.  
  137.          ALT-O .... Sort the dialing directory into ascending sequence
  138.                     by name or number.  Performs a IN MEMORY sort, so
  139.                     there must be enough memory to hold all the phone
  140.                     directory entries.
  141.  
  142.          ALT-G .... Redial the last number dialed.  This command will loop
  143.                     continuously until carrier is signaled by the modem, the
  144.                     Forced Carrier config param is 'TRUE', or the user
  145.                     presses a key.
  146.  
  147.          ALT-E .... Turn Half Duplex ON if it is OFF, or OFF if it
  148.                     is on.  If Half Duplex is ON, then a 'H' will
  149.                     appear in the lower right corner of the screen to
  150.                     remind the user.
  151.  
  152.          ALT-Q .... Hang-up the phone line, put the modem "ON HOOK".
  153.                     Drops the terminal ready signal to the modem for 3
  154.                     seconds and resets the UART.
  155.  
  156.          ALT-W .... Clear the screen.
  157.  
  158.          ALT-P .... Play a tune, at random, from the several tunes
  159.                     prestored in the program.
  160.  
  161.          ALT-F .... Fix time.  That is, mark the current time
  162.                     so that you can measure time used, with the
  163.                     ALT-U command.
  164.  
  165.          ALT-U .... Used, time.  Report the time used since the
  166.                     the last ALT-F command and the last dial of the phone
  167.                     or the start of the program, whichever occured last.
  168.                     Total elapsed time in hours, minutes and seconds,
  169.                     is reported.
  170.  
  171.          ALT-Z .... Toggle monitor mode on/off.
  172.  
  173.  
  174.       The dialing management sub-section has a list of commands also:
  175.  
  176.           A = Add an entry to the dialing directory.
  177.           C = Change an entry in the dialing directory.
  178.           K = Kill an entry in the dialing directory, a sort of the
  179.               directory is recommended after this option or the Add option.
  180.           M = Dial a number not in the directory.
  181.           D = Dial a number that is in the directory.
  182.           S = Stop the modem, after it has dialed, but before it goes online.
  183.               This allows you to dial another number when a previous number
  184.               is busy, without waiting for the modem to timeout waiting for
  185.               carrier.
  186.           F = Display the next page of the directory.
  187.           B = Display the previous page of the directory.
  188.           Q = Quit, returns to the online screen.
  189.  
  190.       Note: When editing Phone Directory entries or Macro Key definitions,
  191.             the program responds to the following editing keys as indicated:
  192.  
  193.             Backspace .... Delete character to the left of cursor.
  194.             Del .......... Delete character under the cursor.
  195.             End .......... Move the cursor to the end of the field.
  196.             ^End ......... Erase from the current cursor position to the
  197.                            end of the field.
  198.             Home ......... Move the cursor to the start of the field.
  199.             Ins .......... Toggle between insert and overwrite mode.
  200.                            When in insert mode the cursor becomes fat.
  201.             Left Arrow ... Move the cursor to the left 1 position.
  202.             Right Arrow .. Move the cursor to the right 1 position.
  203.             RETURN ....... Finish the current field and move to the next.
  204.  
  205.       There are several files associated with the system.  Here is a
  206.       description of each:
  207.  
  208.          TM.COM ......... Absolute program.  The one to execute.
  209.          TM.DOC ......... This file.
  210.          TMODEM.DIR ..... The phone directory, data file.
  211.          TMODEM.KEY ..... Macro key definitions, data file.
  212.          TMODEM.CNF ..... The configuration, data file.  You may need
  213.                           to edit the configuration file, using EDLIN or
  214.                           other DOS compatible editor, so here is a detailed
  215.                           examination of the file:
  216.  
  217.             In position 1-3 of each record in the configuration
  218.             file is a code to identify a parameter.  After the
  219.             "=" the value of the parameter appears.
  220.             The codes are:
  221.  
  222.                    ST=  Stopbits
  223.                    DA=  Databits
  224.                    PA=  Parity. 0=None,1=Even,2=Odd
  225.                    BA=  Baud Rate. 300,1200 or 2400.
  226.                    WA=  Number of ticks in 1/3 of a second,
  227.                         at 4.77 MHz clock.  The value should be
  228.                         larger if the clock is faster.
  229.                         The units for the value is milleseconds,
  230.                         and it is used for waiting, hence the WA=.
  231.                    PR=  Dialing Pre String.
  232.                    PO=  Dialing Post String, use the | character
  233.                         where a RETURN is needed.
  234.                    MI=  Modem initialization string.
  235.                         The default value, AT S0=0|, will cause the
  236.                         modem not to answer the phone.  Again, use
  237.                         the | character where a RETURN is needed.
  238.                    SY=  Modem command string to turn the speaker ON.
  239.                    SN=  Modem command string to turn the speaker OFF.
  240.                    RT=  After carrier timeout has occured, this is
  241.                         the time between redials, in seconds.
  242.                    FC=  Forced Carrier.  Some modems force carrier
  243.                         even when a call is not in progress, if this
  244.                         is the case, set this parameter to TRUE.
  245.                    CT=  Timeout time for carrier to appear, in seconds.
  246.                    DP=  Directory PATH.  This variable tells the program
  247.                         where to look for the phone directory.  This param
  248.                         is provided mainly for people who wish to put the
  249.                         dialing directory on a RAM-disk.
  250.                    XO=  The decimal value of the XON character.  Used to
  251.                         control data flow.  Starts data flow after XOFF has
  252.                         been issued.
  253.                    XF=  The decimal value of the XOFF character.  Used to
  254.                         control data flow.  Stops data flow when issued.
  255.                         Helps insure that buffer overflow does not occur.
  256.                    VT=  Turns on limited VT-100 emulation, using the
  257.                         ANSI escape codes.  Note: if VT-100 emulation is
  258.                         requested, music will not be played, and will show
  259.                         on the screen as text.  This happens becuase of a
  260.                         conflicit between the full ANSI definition and the
  261.                         musical notes.
  262.                    * =  Comment lines.
  263.  
  264.             Note: these entries may also be changed via the ALT-I command.
  265.  
  266.             For Example:   ST=1             |
  267.                            DA=8             |
  268.                            PA=0             |
  269.                            BA=1200          |
  270.                            WA=333           |
  271.                            PR=ATDT          |
  272.                            PO=|             |
  273.                            MI=AT S0=0|      |
  274.                            SY=AT M1|        |     The DEFAULT defaults!
  275.                            SN=AT M0|        |
  276.                            RT=60            |
  277.                            FC=FALSE         |
  278.                            CT=35            |
  279.                            DP=A:\           |
  280.                            XO=17            |
  281.                            XF=19            |
  282.                            VT=FALSE         |
  283.  
  284.  
  285.       If the program is used without a modem, using a direct cable connection,
  286.       all the dialing and modem control strings in the config file should
  287.       be set to empty strings, for example the line with the MI parameter
  288.       should read, "MI=".  Also, when using a direct cable connection, the FC
  289.       parameter should be set to TRUE.
  290.  
  291.       The program has been written to use Hayes compatible commands
  292.       with the modem.  Because the program controls the modem via the
  293.       DTR signal, Data Terminal Ready, the cable between the computer
  294.       and modem must provide a connection for pin 20 and the modem should
  295.       have the internal switches set so that the DTR signal is monitored.
  296.  
  297.       The program uses the Carrier Detect signal from the modem to
  298.       detect when a call has been connected and when to stop redialing,
  299.       for this reason the modem should have it's switches set so that
  300.       the Carrier Detect signal is ONLY sent when present on the phone line.
  301.       If this is not possible, set the FC= parameter, to TRUE.
  302.